com.doclinx.jftr
Class DEBUG

java.lang.Object
  |
  +--com.doclinx.jftr.DEBUG

public final class DEBUG
extends java.lang.Object

Class for general debug information output.


Field Summary
static int CRITICAL
          Output critical msgs
static java.lang.String DBGLOG
          Default debugfile if one is not specified in preference file.
static java.lang.String DBGPRF
          Initialization preference file containing any of three properties: debug = severity, console = boolean, and debugfile = string path name.
static int NONE
          Inhibit debug message
static int STANDARD
          Output critical+std
static int VERBOSE
          Output all messages
static int wLevel
          Severity level (default).
 
Constructor Summary
DEBUG()
           
 
Method Summary
static void close()
          Close debug file.
static void critical(java.lang.String sMsg)
          Output debug message at CRITICAL priority.
static void criticalException(java.lang.String sMsg, java.lang.Throwable oThrowable)
          Output debug message at CRITICAL priority with exception info.
static com.doclinx.jftr.Log getAsLog()
           
static com.doclinx.jftr.Log getAsLog(int severity)
           
static int getLevel()
          Get current severity level.
static void msg(int wLevel, java.lang.String sMsg)
          Output debug message at specified priority.
static void msg(int wLevel, java.lang.String sMsg, java.lang.Throwable oThrowable)
          Output debug message at specified priority.
static void setDebugFile(java.lang.String sPath)
           
static void setLevel(int level)
          Set severity level.
static void setLevel(int level, boolean init)
          Set severity level and reset log file.
static void std(java.lang.String sMsg)
          Output debug message at STANDARD priority.
static void verbose(java.lang.String sMsg)
          Output debug message at VERBOSE priority.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DBGPRF

public static java.lang.String DBGPRF
Initialization preference file containing any of three properties:
  debug     = severity, 
  console   = boolean, and
  debugfile = string path name.
     


DBGLOG

public static java.lang.String DBGLOG
Default debugfile if one is not specified in preference file.


NONE

public static final int NONE
Inhibit debug message

See Also:
Constant Field Values

CRITICAL

public static final int CRITICAL
Output critical msgs

See Also:
Constant Field Values

STANDARD

public static final int STANDARD
Output critical+std

See Also:
Constant Field Values

VERBOSE

public static final int VERBOSE
Output all messages

See Also:
Constant Field Values

wLevel

public static int wLevel
Severity level (default).

Constructor Detail

DEBUG

public DEBUG()
Method Detail

setLevel

public static void setLevel(int level)
Set severity level.

Parameters:
level - Integer value for current severity -- controls amount of log information based upon message priority.
See Also:
severity codes.

setLevel

public static void setLevel(int level,
                            boolean init)
Set severity level and reset log file.

Parameters:
level - Integer value for current severity -- controls amount of log information based upon message priority.
init - If true, empty debug file.
See Also:
severity codes.

getLevel

public static int getLevel()
Get current severity level.

Returns:
bInit If true, empty debug file.
See Also:
severity codes.

close

public static void close()
Close debug file.


std

public static void std(java.lang.String sMsg)
Output debug message at STANDARD priority.

Parameters:
sMsg - String message to output.
See Also:
severity codes.

verbose

public static void verbose(java.lang.String sMsg)
Output debug message at VERBOSE priority.

Parameters:
sMsg - String message to output.
See Also:
severity codes.

critical

public static void critical(java.lang.String sMsg)
Output debug message at CRITICAL priority.

Parameters:
sMsg - String message to output.
See Also:
severity codes.

criticalException

public static void criticalException(java.lang.String sMsg,
                                     java.lang.Throwable oThrowable)
Output debug message at CRITICAL priority with exception info.

Parameters:
sMsg - String message to output.
oThrowable - object exception causing message to be output.
See Also:
severity codes.

msg

public static void msg(int wLevel,
                       java.lang.String sMsg)
Output debug message at specified priority.

Parameters:
wLevel - Priority level of message.
sMsg - String message to output.
See Also:
severity codes.

msg

public static void msg(int wLevel,
                       java.lang.String sMsg,
                       java.lang.Throwable oThrowable)
Output debug message at specified priority.

Parameters:
wLevel - Priority level of message.
sMsg - String message to output.
oThrowable - Throwable associated with this message
See Also:
severity codes.

setDebugFile

public static void setDebugFile(java.lang.String sPath)

getAsLog

public static com.doclinx.jftr.Log getAsLog()

getAsLog

public static com.doclinx.jftr.Log getAsLog(int severity)